sfdc-ux (LC)

1.0.x
(0 reviews)

Update Contact or Appointment details or Queue,Status,Comment and Closing Comment in ACUT

/troubleTicket/{id}

[PATCH]

To update contact or appointment details or queue,status,comment and closing comments in ACUT from Salesforce.

URL
https://nonprod.lc.esb.cloud.lla.com/test/sfdc-ux/sfdc-ux/v1/JM/troubleTicket/{id}

URI Params

NameTypeDescriptionRequired
businessIdString2 letter ISO 3166 country code (CO, HN, CR, DO, SV, GT, WHS etc.) identifying the business unit. Expected:JM,AI,AG,VG,KY,DM,GD,MS,KN,LC,VC,TCY
idStringACUT Ticket NumberY

Headers

NameTypeDescriptionRequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.Y

Contact Details update

Body Definitions

NameTypeDescriptionRequired
ticketTypestringTickeType : PHONE/DSL/IPTVY
channel.idstringChannel IdY
channel.namestringChannel NameY
relatedParty[0].idstringSalesforce contact idY
relatedParty[0].namestringContact NameN
relatedParty[0].@schemaLocationstringDefault: https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.jsonY*
relatedParty[0].@typestringDefault: RelatedPartyWithContactInfoY*
relatedParty[0].rolestringDefault:contactY*
relatedParty[0].@referredTypestringDefault: IndividualY*
relatedParty[0].contactMedium[].@referredTypestringDefault: TelephoneMediumY*
relatedParty[0].contactMedium[].mediumTypestringDefault: TelephoneNumberY*
relatedParty[0].contactMedium[].characteristic.phoneNumberstringContact PhoneY*
relatedParty[1].idstringSalesforce contact idY
relatedParty[1].namestringAlternate Contact NameN
relatedParty[1].@schemaLocationstringDefault: https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.jsonY*
relatedParty[1].@typestringDefault: RelatedPartyWithContactInfoY*
relatedParty[1].rolestringDefault: alternateContactY*
relatedParty[1].@referredTypestringDefault: IndividualY*
relatedParty[1].contactMedium[].@referredTypestringDefault: TelephoneMediumY*
relatedParty[1].contactMedium[].mediumTypestringDefault: TelephoneNumberY*
relatedParty[1].contactMedium[].characteristic.phoneNumberstringContact PhoneY*
relatedParty[2].idstringSalesforce User idY
relatedParty[2].namestringUser NameN
relatedParty[2].@schemaLocationstringDefault: https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.jsonY*
relatedParty[2].@typestringDefault: RelatedPartyWithContactInfoY*
relatedParty[2].rolestringDefault: userY*
relatedParty[2].@referredTypestringDefault: IndividualY*
relatedParty[2].contactMedium[].@referredTypestringDefault: EmailMediumY*
relatedParty[2].contactMedium[].mediumTypestringDefault: EmailAddressY*
relatedParty[2].contactMedium[].characteristic.emailAddressstringEmail address of userY*

Sample request

{
    "ticketType": "DSL",
    "channel": {
        "id": "SALESFORCE",
        "name": "SALESFORCE123"
    },
    "relatedParty": [
        {
            "id": "003dq000004yL0rAAE",
            "name": "KELLY",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "role": "contact",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "TelephoneMedium",
                    "mediumType": "TelephoneNumber",
                    "characteristic": {
                        "phoneNumber": "8879541292"
                    }
                }
            ]
        },
        {
            "id": "003dq000004yL0rAAE",
            "name": "JELLY",
            "role": "alternateContact",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "TelephoneMedium",
                    "mediumType": "TelephoneNumber",
                    "characteristic": {
                        "phoneNumber": "8763710888"
                    }
                }
            ]
        },
        {
            "id": "003dq000004yL0rAAE",
            "name": "Juliet Kelvin",
            "role": "user",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "EmailMedium",
                    "mediumType": "EmailAddress",
                    "characteristic": {
                        "emailAddress": "juliet@abc.com"
                    }
                }
            ]
        }
    ]
}

Sample response

{
    "ticketType": "DSL",
    "channel": {
        "id": "SALESFORCE",
        "name": "SALESFORCE123"
    },
    "relatedParty": [
        {
            "id": "003dq000004yL0rAAE",
            "name": "KELLY",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "role": "contact",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "TelephoneMedium",
                    "mediumType": "TelephoneNumber",
                    "characteristic": {
                        "phoneNumber": "8879541292"
                    }
                }
            ]
        },
        {
            "id": "003dq000004yL0rAAE",
            "name": "JELLY",
            "role": "alternateContact",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "TelephoneMedium",
                    "mediumType": "TelephoneNumber",
                    "characteristic": {
                        "phoneNumber": "8763710888"
                    }
                }
            ]
        },
        {
            "id": "003dq000004yL0rAAE",
            "name": "Juliet Kelvin",
            "role": "user",
            "@schemaLocation": "https://github.com/tmforum-apis/Open_Api_And_Data_Model/blob/master/schemas/EngagedParty/RelatedPartyWithContactInfo.schema.json",
            "@type": "RelatedPartyWithContactInfo",
            "@referredType": "Individual",
            "contactMedium": [
                {
                    "@referredType": "EmailMedium",
                    "mediumType": "EmailAddress",
                    "characteristic": {
                        "emailAddress": "juliet@abc.com"
                    }
                }
            ]
        }
    ]
}

Appointment Details update

Body Definitions

NameTypeDescriptionRequired
ticketTypestringTickeType : PHONE/DSL/IPTVY
channel.idstringChannel IdY
channel.namestringChannel NameY
relatedEntity[0].idstringSalesforce appointment idY
relatedEntity[0].descriptionstringReason for the appointmentY
relatedEntity[0].validFor.startDateTimedatetimeStart datetime of appointmentY
relatedEntity[0].validFor.endDateTimedatetimeEnd datetime of appointmentY
relatedEntity[0].note[0].textstringComments for the appointmentN
relatedEntity[0].note[0].@typestringDefault: NoteY*
relatedEntity[0].rolestringDefault: requestedAppointmentY
relatedEntity[0].@typestringDefault: RelatedEntityY
relatedEntity[0].@referredTypestringDefault: AppointmentY

Sample request

{
    "ticketType": "DSL",
    "channel": {
        "id": "SALESFORCE",
        "name": "SALESFORCE123"
    },
    "relatedEntity": [
        {
            "id": "00Tdq000006UkI5EAK",
            "description": "CUSTOMER REQUESTED",
            "validFor": {
                "startDateTime": "2025-12-05T08:30:00.000+05:30",
                "endDateTime": "2025-12-05T12:30:00.000+05:30"
            },
            "note": [
                {
                    "text": "updating appointment to another slot",
                    "@type": "Note"
                }
            ],
            "role": "requestedAppointment",
            "@type": "RelatedEntity",
            "@referredType": "Appointment"
        }
    ]
}

Sample response

{
    "ticketType": "DSL",
    "channel": {
        "id": "SALESFORCE",
        "name": "SALESFORCE123"
    },
    "relatedEntity": [
        {
            "id": "00Tdq000006UkI5EAK",
            "description": "CUSTOMER REQUESTED",
            "validFor": {
                "startDateTime": "2025-12-05T08:30:00.000+05:30",
                "endDateTime": "2025-12-05T12:30:00.000+05:30"
            },
            "note": [
                {
                    "text": "updating appointment to another slot",
                    "@type": "Note"
                }
            ],
            "role": "requestedAppointment",
            "@type": "RelatedEntity",
            "@referredType": "Appointment"
        }
    ]
}

Queue, Status, Comment and Closing Comments Update

Body Definitions

NameTypeDescriptionRequired
ticketTypestringTickeType : PHONE/DSL/IPTVY
channel.idstringChannel IdY
channel.namestringChannel NameY
relatedEntity[0].idstringAssigned group Id/ Queue IdN
relatedEntity[0].rolestringDefault: AssignedGroupY*
relatedEntity[0].@referredTypedatetimeDefault: OrganizationY*
troubleTicketCharacteristic[0].namedatetimeDefault: externalStatusY*
troubleTicketCharacteristic[0].valuestringStatus of ticketY
note[0].idstringDefault: ClosingCommentY*
note[0].textstringClosing commentY
note[0].@typestringDefault: NoteY*
note[0].idstringDefault: CommentY*
note[0].textstringComment of the ticketN
note[0].@typestringDefault: NoteY*

Sample request

{
  "ticketType": "DSL",
  "channel": {
    "id": "SALESFORCE",
    "name": "SALESFORCE123"
  },
  "relatedEntity": [
    {
      "id": "O",
      "role": "AssignedGroup",
      "@referredType": "Organization"
    }
  ],
  "troubleTicketCharacteristic": [
    {
      "name": "externalStatus",
      "value": "assigned"
    }
  ],
  "note": [
    {
      "id": "ClosingComment",
      "text": "This is closing comment",
      "@type": "Note"
    },
    {
      "id": "Comment",
      "text": "Added new comments",
      "@type": "Note"
    }
  ]
}

Sample response

{
  "ticketType": "DSL",
  "channel": {
    "id": "SALESFORCE",
    "name": "SALESFORCE123"
  },
  "relatedEntity": [
    {
      "id": "O",
      "role": "AssignedGroup",
      "@referredType": "Organization"
    }
  ],
  "troubleTicketCharacteristic": [
    {
      "name": "externalStatus",
      "value": "assigned"
    }
  ],
  "note": [
    {
      "id": "ClosingComment",
      "text": "This is closing comment",
      "@type": "Note"
    },
    {
      "id": "Comment",
      "text": "Added new comments",
      "@type": "Note"
    }
  ]
}

Reviews